Database Connection Parameters
The connection parameters on the Database Connection screen vary depending on the target server you select. The connection parameters for the supported target servers are:
- Connection Method
-
Specifies the type of connection you want to use. Select JDBC to connect using JDBC. Or, select ODBC to connect using the ODBC data source that you have defined.
- ODBC Data Source
-
Specifies the data source to which you want to connect. The drop-down list displays the data sources that are defined on your computer.
-
Note: Reverse engineering a model from a database using the ODBC connection retrieves only 64 characters.
- Invoke ODBC Administrator
-
Specifies whether you want to start the ODBC Administrator software and display the Select Data Source dialog. You can then select a previously defined data source, or create a data source.
- Connection String
-
Specifies the connection string based on your JDBC instance and Azure Synapse database namein the following format:
jdbc: sqlserver://<server name>.sql.azuresynapse.net:1433;
For example, jdbc:sqlserver://localhost.sql.azuresynapse.net:1433;
- Database
-
Specifies the name of the database that you want to connect to.
- Connection Type
-
Specifies the type of connection you want to use. Select Use Native Connection to connect using the API provided by the SQL Server Native client software. Select Use ODBC Data to connect using the ODBC data source that you have defined. Select Use JDBC Connection to connect using JDBC.
- Server
-
Specifies the name of the server where the database is installed.
- Database
-
Specifies the name of the database that you want to connect to.
- Use Encrypted Connection
-
Indicates that the SQL Server connection that is being established is encrypted to guarantee privacy.
- ODBC Data Source
-
Specifies the data source to which you want to connect. The drop-down list displays the data sources that are defined on your computer.
- Invoke ODBC Administrator
-
Specifies whether you want to start the ODBC Administrator software and display the Select Data Source dialog. You can then select a previously defined data source, or create a data source.
- Instance
-
Specifies the JDBC instance to which you want to connect.
- Connection String
-
Specifies the connection string based on your JDBC instance and SQL Server database name in the following format:
jdbc:sqlserver://<servername>:1433;database=<SqlDBname>
-
For example, jdbc:sqlserver://localhost:1433
- Connection Type
-
Specifies the type of connection you want to use. Select Use Native Connection to connect using the API provided by the SQL Server Native client software. Select Use ODBC Data to connect using the ODBC data source that you have defined. Select Use JDBC Connection to connect using JDBC.
- Server
-
Specifies the name of the server where the database is installed.
Note: You may need to append the SQL Azure server name to the login in the connection string using the <login>@<server> notation. If you do, separate the login and the SQL Azure server name with the at (@) symbol. For more information, see Connecting to SQL Azure.
- Database
-
Specifies the name of the database that you want to connect to.
- Use Encrypted Connection
-
Indicates that the SQL Server connection that is being established is encrypted to guarantee privacy.
- ODBC Data Source
-
Specifies the data source to which you want to connect. The drop-down list displays the data sources that are defined on your computer.
- Invoke ODBC Administrator
-
Specifies whether you want to start the ODBC Administrator software and display the Select Data Source dialog. You can then select a previously defined data source, or create a data source.
- Instance
-
Specifies the JDBC instance to which you want to connect.
- Connection String
-
Specifies the connection string based on your JDBC instance and SQL Server database name in the following format:
jdbc:sqlserver://<servername>:<port>
For example, jdbc:sqlserver://localhost:1433 - Connect to Managed Instance
-
Specifies whether the connection should be to an Azure SQL Managed Instance.
Note: erwin Data Modeler 2021 R1 supports Azure AD accounts connection via ODBC.
- Connection Method
-
Specifies the type of connection you want to use. Select Use Native Connection to connect using the API provided by the SQL Server Native client software. Select Use JDBC Connection to connect using JDBC.
- Server
-
Specifies the name of the server where the database is installed.
- Database
-
Specifies the name of the database that you want to connect to.
- Connection String
-
Specifies the connection string based on your JDBC instance and SAP ASE database name in the following format:
jdbc:sybase:Tds:<servername>:5000
For example, jdbc:sybase:Tds:localhost:5000
- Server
-
Specifies the name of the server where the database is installed.
- Database
-
Specifies the name of the database that you want to connect to.
- Connection Method
-
Specifies the type of connection you want to use. Select ODBC to connect using the ODBC data source that you have defined. Select JDBC to connect using JDBC.
- ODBC Data Source
- Specifies the data source to which you want to connect. The drop-down list displays the data sources that are defined on your computer.
- Invoke ODBC Administrator
- Specifies whether you want to start the ODBC Administrator software and display the Select Data Source dialog. You can then select a previously defined data source, or create a data source.
- Instance
-
Specifies the JDBC instance to which you want to connect.
-
For a cloud-based connected, the instance name is as follows:
-
TNS_ADMIN=<Path of unzipped cloud wallet file>
-
For example,TNS_ADMIN=C:\\Users\\MyUser\\Wallet_DBTEST
-
Note: Ensure that you have downloaded, saved, and unzipped the cloud wallet file.
- Connection String
-
Specifies the connection string based on your JDBC instance in the following format:
jdbc:oracle:thin:@//<servername>:1521/
For example, JDBC:ORACLE:thin:@//localhost:1521/
-
For a cloud instance, the connection string is as follows:
-
jdbc:oracle:thin:@<dbname_priority>?
-
For example, jdbc:oracle:thin:@dbtest_medium?
- Metastore Database
-
Specifies the relational database that stores the metadata for Hive tables and partitions in a relational database. This parameter is specific to Hive.
Note: Ensure that you install the drivers that correspond to the Metastore Database that you select.
- ODBC Data Source
-
Specifies the data source to which you want to connect. The drop-down list displays the data sources that are defined on your computer.
- Invoke ODBC Administrator
-
Specifies whether you want to start the ODBC Administrator software and display the Select Data Source dialog. You can then select a previously defined data source, or create a data source.
Note:
- For FE or Alter Script process, on the Hive Connection dialog, always set the Metastore Database to Default and the ODBC Data Source to relevant Hive connection driver.
- For Reverse Engineering from a PostgreSQL database, use the PostgreSQL ANSI ODBC driver.
- Alternate Catalog
-
Specifies the name of the alternate catalog that you want to use for the connection. If you leave this value empty, the application connects to the system catalog. If necessary, consider connecting to the alternate catalog for faster reverse engineering.
You can connect to a MariaDB database using Generic ODBC driver or a JDBC driver. Based on your selection under Connection Method, the connection parameters are as follows:
- ODBC Generic
-
ODBC Data Source
-
Specifies the data source to which you want to connect. The drop-down list displays the data sources that are defined on your computer.
-
Invoke ODBC Administrator
-
Specifies whether you want to start the ODBC Administrator software and display the Select Data Source dialog. You can then select a previously defined data source, or create a data source.
-
Database
-
Specifies the name of the database that you want to connect to.
- JDBC
-
Connection String
-
Specifies the connection string for MariaDB database server in the following format:
- jdbc:mariadb.
-
Hostname/IP
-
Specifies the hostname or IP address of the server where your database is hosted.
-
Port
-
Specifies the port configured for your database.
-
Database
-
Specifies the name of the database that you want to connect to.
Note: For the JDBC connection to work seamlessly, ensure that you download the required JDBC driver and rename it to mariadb-java-client-2.6.1.jar.
- Connection Method
-
Specifies the type of connection you want to use. Select Direct to connect to your cluster directly. Select Connection String to connect to your cluster using a connection string.
- Hostname/IP
-
Specifies the hostname or IP address of the server where your cluster is hosted.
- Port
-
Specifies the port configured for your cluster.
- Connection String
-
Specifies the path to the secure connect ZIP file in the following format:
C:\<file name>.zip
For example, C:\TempCass\secure-connect-testdb.zip
- Connection Method
-
Specifies the type of connection you want to use. Select Direct to connect to connect to your database directly. Select Connection String to connect to your database using a connection string.
- Hostname/IP
-
Specifies the hostname or IP address of the server where your database is hosted.
- Port
-
Specifies the port configured for your database.
- Database
-
Specifies the name of the database to which you want to connect.
- LDAP
-
Specifies whether to use LDAP protocol for authentication and authorization.
- Connection String
-
Specifies the connection string in the following format:
mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]
For example, mongodb+srv://myusername:****
@cluster0.v7gra.mongodb.net/test?retryWrites=true&w=majority
- Connection Method
-
Specifies the type of connection you want to use. Select Direct to connect to connect to your bucket directly. Select Connection String to connect to your bucket using a connection string.
- Hostname/IP
-
Specifies the hostname or IP address of the server where your bucket is hosted.
- Port
-
Specifies the port configured for your bucket.
- Bucket
-
Specifies the name of the bucket to which you want to connect.
- SSL Certificate Path
-
Specifies the path to the SSL certificate, if you have one. You can leave this field blank.
- Connection String
-
Specifies the connection string in the following format:
couchbases://<database server>/<bucket>?ssl=no_verify
For example, couchbases://server1.dp.cloud.couchbase.com/testbucket?ssl=no_verify
You can connect to a MySQL database using Generic ODBC driver or a JDBC driver. Based on your selection under Connection Method, the connection parameters are as follows:
- ODBC Generic
-
ODBC Data Source
-
Specifies the data source to which you want to connect. The drop-down list displays the data sources that are defined on your computer.
Note: erwin DM 2021 R1 does not support the Unicode driver. -
Invoke ODBC Administrator
-
Specifies whether you want to start the ODBC Administrator software and display the Select Data Source dialog. You can then select a previously defined data source, or create a data source.
-
Database
-
Specifies the name of the database that you want to connect to.
Note: For Reverse Engineering a MySQL database, use the MySQL ANSI ODBC driver.
- JDBC
-
Hostname/IP
-
Specifies the hostname or IP address of the server where your database is hosted.
-
Port
-
Specifies the port configured for your database.
-
Database
-
Specifies the name of the database that you want to connect to.
Note: For the JDBC connection to work seamlessly, ensure that you download the required JDBC driver and rename it to mysql-connector-java-8.0.22.jar.
You can connect to a Snowflake database using Generic ODBC driver or a JDBC driver. Based on your selection under Connection Method, the connection parameters are as follows:
- ODBC Generic
-
ODBC Data Source
-
Specifies the data source to which you want to connect. The drop-down list displays the data sources that are defined on your computer.
-
Invoke ODBC Administrator
-
Specifies whether you want to start the ODBC Administrator software and display the Select Data Source dialog. You can then select a previously defined data source, or create a data source.
- JDBC
-
Connection String
-
Specifies the connection string based on your JDBC instance and Snowflake database name. For example, jdbc:snowflake://<account_name>.snowflakecomputing.com/
Connection String is a mandatory parameter.
-
Database
-
Specifies the name of the database that you want to connect to.
Database is a mandatory parameter.
-
Warehouse
-
Specifies the name of the warehouse that you want to connect to.
Warehouse is a mandatory parameter.
-
Role
-
Specifies the role that you want to use to connect to the database.
Role is a mandatory parameter.
-
Schema
-
Specifies the name of the schema that you want to connect to.
The Parameters/Value Options in erwin® Data Modeler Workgroup Edition are:
SQL Server and SAP ASE:
- Server
-
Enter the server name.
- Database
-
Enter the name of the database.
Oracle:
- Connection String
-
Enter the connection string (TNSNames entry).
Note: erwin Data Modeler (DM) 32-bit version does not support JDBC connectivity.
Copyright © 2021 Quest Software Inc. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies. |